Update Contribution Guide #3269
Conversation
|
Thanks Kyaa-dost for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request 🙌 |
ghost
assigned 
|
Actually wondering if we want to simplify this and then use the Wiki feature for all this developer/contributor-focused documentation like VS Code does here: https://github.com/Microsoft/vscode/wiki See comment: #3318 (comment) Thoughts? Let's discuss at our next toolkit meeting. |
|
@Kyaa-dost now that we're moving this all to the wiki, should we just update this document to be more brief and point mainly to the wiki instead? |
Co-authored-by: Michael Hawker MSFT (XAML Llama) <[email protected]>
|
This PR has been marked as "needs attention 👋" and awaiting a response from the team. |
readme.md
Outdated
|
|
||
| # Windows Community Toolkit | ||
| # Windows Community Toolkit :briefcase: |
There was a problem hiding this comment.
We may want to the toolbox emoji 🧰 or our own logo maybe from our design assets?
|
This PR has been marked as "needs attention 👋" and awaiting a response from the team. |
readme.md
Outdated
| ## NuGet Packages | ||
| NuGet is a standard package manager for .NET applications which is built into Visual Studio. To open the UI, from your open solution, choose the *Tools* menu > *NuGet Package Manager* > *Manage NuGet packages for solution...* . Enter one of the package names below to search for it online. | ||
| ## NuGet Packages :package: | ||
| NuGet is a standard package manager for .NET applications which is built into Visual Studio. From your open solution, choose the *Tools* menu > *NuGet Package Manager* > *Manage NuGet packages for solution...* Enter one of the package names mentioned in [Windows Community Toolkit Nuget Packages](https://docs.microsoft.com/en-us/windows/communitytoolkit/nuget-packages) table to search for it online. |
There was a problem hiding this comment.
It feels wordy and seems like it lacks context. We just tell them how to get the packages with out saying "To get our nuget packages...".
Maybe instead of telling the user how to install NuGet our packages, we should let them know our NuGet package IDs. Or just link to the project wiki and list the IDs there. From what I understand how to get NuGet packages from nuget.org is a fairly common knolege in the community. Also how to obtain nuget packages depends on your eviorment.
There was a problem hiding this comment.
The description is mirroring the Nuget Package page. I can work on the proper wording.
At this point, they are just setting up and people come from all different backgrounds so I am not certain if we need this much detail here in the readme. I am not certain about the ID's. Perhaps if you want to create a list in the wiki and then we can see if we can link that in the readme?
There was a problem hiding this comment.
O I am not saying to copy that page in the readme. Just maybe keep it shorter and not try to explain to the users how to install the packages. Most users will probably just want the package IDs, which would clutter the readme. Maybe making it more succinct and leave the rest to the Nuget Package page.
There was a problem hiding this comment.
Just fixed the wording for steps. It is already concise enough as this is all the information they need and the whole focus of this readme is to provide a glimpse of the information on steps and redirect it to the NuGet package.
If you have a suggestion, create a commit suggestion and we can review if that's what we want in the content 😊
There was a problem hiding this comment.
Want to get the rest updated, @RosarioPulella feel free to submit a follow-on PR with any suggestions for changes.
|
Going to merge this in now so we can get the link to MyGet off the readme and finish that transition. |
Yayyyyyy Lets do it 🚀 🚀 |
Fixes #
Contribution Guide seems to be outdated and missing some info on troubleshooting regarding Issues, Features, PR, Docs etc.
PR Type
What kind of change does this PR introduce?
Documentation content changes
What is the current behavior?
Outdated Guide
What is the new behavior?
Updated Contribution Guide with steps on troubleshooting issues, features, PR's, WCTDocs etc
PR Checklist
Please check if your PR fulfills the following requirements:
Other information